Skip to content

Conversation

@kate-goldenring
Copy link
Contributor

The latest python template uses componentize-py 0.16. This updates the docs to not reference a version to enable templates to update independently of the docs. requirements.txt` contains the required versions.

@itowlson
Copy link
Contributor

itowlson commented Apr 6, 2025

@dicej I recall we had a reason for locking the version - originally (fermyon/developer#1174) this block omitted the version (as this PR proposes), but I think there was a thing where it was picking up latest and that didn't work with the Spin of the time or something? We changed it in fermyon/developer#1233 to lock to a version, but the PR has no description and no linked issue. But both of this predate requirements.txt.

Do you recall the original issue? Is locking still relevant if someone is installing outside of requirements.txt (which seems to be what this block is covering)?

Which brings another question (for a separate PR) of should we move/remove this - I see there is a note saying "you don't need to do this if you're using requirements.txt" but I feel like readers will only see that after they've run the manual install...!

TLDR: if Joel is happy then I am happy

@dicej
Copy link

dicej commented Apr 7, 2025

Looks like there are three options here:

  1. pip3 install -r requirements.txt
  2. pip3 install componentize-py==$BLESSED_KNOWN_GOOD_VERSION
  3. pip3 install componentize-py

(or some combination of the above)

I'd vote for option 1 all by itself (i.e. remove the pip3 install componentize-py... part altogether). Option 2 would require updating the templates and the docs in lock-step or otherwise risk falling behind again. Option 3 would require updating componentize-py, the docs, and the templates in lock-step, and that sounds impractical to me.

@kate-goldenring kate-goldenring force-pushed the remove-componentize-py-version branch from 52c6ee0 to c51eafa Compare April 7, 2025 21:02
@kate-goldenring
Copy link
Contributor Author

Just using requirements.txt sounds good to me @dicej and @itowlson. I just updated the docs to just reference that installation path.

Copy link
Contributor

@itowlson itowlson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me - thank you for simplifying this, it's much more focused now!

@kate-goldenring kate-goldenring merged commit 0ca31c5 into spinframework:main Apr 9, 2025
3 checks passed
@kate-goldenring kate-goldenring deleted the remove-componentize-py-version branch April 9, 2025 16:52
@michelleN michelleN added this to the initial-bug-bash milestone Apr 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants